refactor: use pathlib utilities to shorten code #1855
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bearomorphism
requested review from
Lee-W,
noirbizarre and
woile
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1855 +/- ##
==========================================
- Coverage 97.99% 97.98% -0.01%
==========================================
Files 60 60
Lines 2692 2684 -8
==========================================
- Hits 2638 2630 -8
Misses 54 54 ☔ View full report in Codecov by Sentry. |
bearomorphism
force-pushed
the
pathlib-refactor
branch
from
0008e21 to
d058fa2
Compare
There was a problem hiding this comment.
Pull request overview
Refactors file IO across core Commitizen commands/config and the test suite to use pathlib.Path convenience APIs (read_text, read_bytes, write_bytes, etc.), reducing boilerplate and aligning IO patterns.
Changes:
- Replace
open(...).read()/Path.open(...).read()patterns withPath.read_text()in tests andinfo()helpers. - Replace binary config reads/writes with
Path.read_bytes()/Path.write_bytes()in TOML config handling and config loading. - Adjust a commit-command test fixture to write/read the backup message using
Pathutilities and correct working-directory expectations.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_conf.py | Simplifies TOML config content assertions using Path.read_text(). |
| tests/test_changelog.py | Uses Path.read_text() for loading changelog fixture content. |
| tests/test_bump_update_version_in_files.py | Replaces manual file opening with Path.read_text() when aggregating regression output. |
| tests/conftest.py | Switches to append-mode writes via open(..., "a") for generated pyproject.toml test content. |
| tests/commands/test_init_command.py | Reads generated config files via Path.read_text() and parses JSON/YAML from strings. |
| tests/commands/test_commit_command.py | Updates backup-message fixture to use Path.write_text() and ensure correct cwd for the command. |
| tests/commands/test_check_command.py | Updates mocks to patch Path.read_text() instead of open(). |
| tests/commands/test_changelog_command.py | Replaces repeated file reads with Path.read_text() across changelog command tests. |
| tests/commands/test_bump_command.py | Uses append-mode Path.open("a") and Path.read_text() for assertions on bumped files. |
| commitizen/cz/jira/jira.py | Uses Path.read_text() for bundled info text. |
| commitizen/cz/customize/customize.py | Uses Path(info_path).read_text() for external info file support. |
| commitizen/cz/conventional_commits/conventional_commits.py | Uses Path.read_text() for bundled info text. |
| commitizen/config/toml_config.py | Simplifies TOML reads/writes with read_bytes() / write_bytes(). |
| commitizen/config/init.py | Loads config bytes via Path.read_bytes() when creating config objects. |
| commitizen/commands/commit.py | Uses Path.read_text() when reading the temporary editor file and backup message. |
| commitizen/commands/check.py | Uses Path.read_text() to load commit messages from --commit-msg-file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bearomorphism
changed the title
bearomorphism
force-pushed
the
pathlib-refactor
branch
from
d058fa2 to
16d8ee8
Compare
Collaborator
Author
|
@copilot what can you assist me with this PR? |
|
@bearomorphism I've opened a new pull request, #1856, to work on those changes. Once the pull request is ready, I'll request review from you. |
woile
approved these changes
Feb 9, 2026
Collaborator
Author
|
Thanks for quick review, Santi! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
Was generative AI tooling used to co-author this PR?
Cursor
Steps to Test This Pull Request
Run
uv run poe test.